/**
 * OVERVIEW
 *
 * Intent here is to demo that redirects fetched using the latest SHA from
 * content match those fetched with refs from the latest version metadata.
 *
 * Note that as we make changes to how version metadata is updated, we expect
 * this demo will no longer work. This is intentional, as version metadata will
 * start reflecting the `ref` and `sha` at the last point the version metadata
 * was updated, which will often fall behind the `sha` of the latest content
 * upload.
 *
 * HOW TO USE THIS FILE
 *
 * Drop this file in `build-libs/__tests__/latest-content-sha-demo.test.ts`,
 * in the `dev-portal` repo, then run `npm run test -- latest-content-sha-demo`.
 */

import getLatestContentShaForProduct from '../get-latest-content-sha-for-product'
import fetchGithubFile from '@build-libs/fetch-github-file'
import { PRODUCT_REDIRECT_ENTRIES } from '@build-libs/redirects'

/**
 * Mirror the previous implementation of the function, which fetched
 * version metadata. We'll use this to compare the new `sha` approach with
 * the existing `sha` values that correspond to each `ref`.
 */
async function getLatestVersionMetadata(product) {
	const contentUrl = new URL('https://content.hashicorp.com')
	contentUrl.pathname = `/api/content/${product}/version-metadata/latest`
	return await fetch(contentUrl.toString()).then((res) => res.json())
}

/**
 * Run demo "tests"
 */
describe('latestContentShaDemo', () => {
	PRODUCT_REDIRECT_ENTRIES.forEach(({ repo, path }) => {
		/**
		 * Demo that the SHA matches between nav-data and version metadata.
		 * This is mostly what we care about, we're asserting that the `sha`
		 * in `nav-data` references an equivalent point in git history as the
		 * `ref` in version metadata.
		 */
		it(`demos that the latest SHA for nav-data in "${repo}" matches the SHA in the latest version metadata`, async () => {
			const latestSha = await getLatestContentShaForProduct(repo)
			const latestVersionMetadata = await getLatestVersionMetadata(repo)
			expect(latestSha).toBe(latestVersionMetadata.result.sha)
		})

		/**
		 * Demo that the redirects file is identical, which is mostly asserting
		 * that `fetchGithubFile` can work with a `ref` or `sha`. We skip
		 * private repos, as fetching that data would require authentication.
		 */
		if (['hcp-docs', 'sentinel', 'ptfe-releases'].includes(repo)) {
			console.log(`Skipping test for "${repo}" repo, as it's a private repo.`)
		} else {
			it(`demos that the redirects fetched from "${repo}" using the latest version metadata ref match redirects fetched from "${repo}" using the latest nav-data SHA`, async () => {
				// Previous approach, using version metadata
				const latestVersionMetadata = await getLatestVersionMetadata(repo)
				const redirectsFromRef = await fetchGithubFile({
					owner: 'hashicorp',
					repo: repo,
					path: path,
					ref: latestVersionMetadata.result.ref,
				})
				// New approach, using SHA from nav-data
				const latestSha = await getLatestContentShaForProduct(repo)
				const redirectsFromSha = await fetchGithubFile({
					owner: 'hashicorp',
					repo: repo,
					path: path,
					ref: latestSha,
				})
				expect(redirectsFromRef).toBe(redirectsFromSha)
			})
		}
	})
})